Skip to content

Refactor Dijkstra pseudo-code and function for readability and type s… #11875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Refactor Dijkstra pseudo-code and function for readability and type s… #11875

wants to merge 1 commit into from

Conversation

jeffreyyancey
Copy link
Contributor

@jeffreyyancey jeffreyyancey commented Oct 7, 2024 •
edited
Loading

Refactor Dijkstra pseudo-code and function for readability and type safety

Description:

This pull request refactors the Dijkstra algorithm pseudo-code and function to improve readability and ensure type safety. Key changes include:

  • Updated the pseudo-code to enhance clarity, reflecting recent optimizations and improvements in variable naming.
  • Added type hints to the dijkstra function and its variables, improving overall readability and code quality.
  • Introduced a costs dictionary to track the minimum costs for reaching each node, which helps avoid redundant heap pushes.
  • Adjusted line lengths to comply with PEP 8 style guidelines.

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@jeffreyyancey
Refactor Dijkstra pseudo-code and function for readability and type s…
c988148 
…afety

- Updated pseudo-code to reflect optimizations and variable naming improvements
- Added type hints to the `dijkstra` function and variables for enhanced clarity
- Introduced a `costs` dictionary to track minimum costs, avoiding redundant heap pushes
- Adjusted line lengths to comply with style guidelines
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jeffreyyancey